Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs
Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs
Query Parameters
- page string
Default value:
0
Number of page to get results from
- size string
Possible values:
<= 100
Default value:
10
Size of each page
- externalIds string[]
External IDs
- 200
Page of sharing states
- application/json
- Schema
- Example (from schema)
Schema
- totalElements int64
Total number of all results in all pages
- totalPages int32
Total number pages
- page int32
Current page number
- contentSize int32
Number of results in the page
content object[]
Collection of results in the page
externalId stringThe external identifier of the business partner for which the sharing state entry was created.
sharingStateType stringPossible values: [
Pending
,Success
,Error
,Initial
,Ready
]One of the sharing state types of the current sharing state.
sharingErrorCode stringPossible values: [
SharingProcessError
,SharingTimeout
,BpnNotInPool
,MissingTaskID
]One of the sharing error codes in case the current sharing state type is "error".
sharingErrorMessage stringThe error message in case the current sharing state type is "error".
sharingProcessStarted date-timeThe date and time when the sharing process was started.
taskId stringThe orchestrator task identifier that was created
{
"totalElements": 0,
"totalPages": 0,
"page": 0,
"contentSize": 0,
"content": [
{
"externalId": "string",
"sharingStateType": "Pending",
"sharingErrorCode": "SharingProcessError",
"sharingErrorMessage": "string",
"sharingProcessStarted": "2024-07-15",
"taskId": "string"
}
]
}